Skip to content

chore: fix inclusive naming in certificates docstring library#381

Open
lucabello wants to merge 1 commit intomainfrom
lucabello-patch-1
Open

chore: fix inclusive naming in certificates docstring library#381
lucabello wants to merge 1 commit intomainfrom
lucabello-patch-1

Conversation

@lucabello
Copy link

This Dummy word fails the automatic inclusive naming check and hurts our CI :) Could we fix this?

This `Dummy` word fails the automatic inclusive naming check and hurts our CI :) Could we fix this?
@lucabello lucabello requested a review from a team as a code owner March 25, 2026 09:40
Copy link
Contributor

@tonyandrewmeyer tonyandrewmeyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should take this opportunity to do this more thoroughly?

$ rg -i dummy -c
interfaces/s3/interface/v1/interface.yaml:1
interfaces/tls-certificates/tests/unit/dummy_provider_charm/charmcraft.yaml:2
interfaces/tls-certificates/tests/unit/dummy_requirer_charm/charmcraft.yaml:2
interfaces/tls-certificates/tests/unit/dummy_provider_charm/src/charm.py:2
interfaces/tls-certificates/tests/unit/dummy_requirer_charm/src/charm.py:5
interfaces/tls-certificates/tests/unit/test_requires.py:23
interfaces/certificate_transfer/tests/unit/test_certificate_transfer_provides_v1.py:2
interfaces/certificate_transfer/tests/unit/test_certificate_transfer_requires_v1.py:2
interfaces/tls-certificates/tests/integration/charms/provider/charm.py:2
interfaces/certificate_transfer/src/charmlibs/interfaces/certificate_transfer/__init__.py:4
interfaces/tls-certificates/tests/integration/charms/requirer/charm.py:2
interfaces/tls-certificates/tests/unit/test_provides.py:3
snap/tests/unit/test_snap.py:3
interfaces/k8s_backup_target/tests/unit/test_backup_target.py:6
pathops/tests/unit/conftest.py:2
pathops/tests/functional/conftest.py:2

@tonyandrewmeyer
Copy link
Contributor

This Dummy word fails the automatic inclusive naming check and hurts our CI :)

I'm curious how the docstring of a PyPI package hits your CI. Does your language check look through all your dependencies? Via the packed charm artifact perhaps? Do you have this library vendored into your repository?

@lucabello
Copy link
Author

Why not!

We hit this problem with the vendored charm library version of the TLS library, it wouldn't trigger for the PyPI version; I thought I would open the PR here regardless though, since if at some point some check of the same kind runs on this repository, we don't wanna hit the problem again :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants